<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Jetson Inference: Video Streaming</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="NVLogo_2D.jpg"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Jetson Inference
   </div>
   <div id="projectbrief">DNN Vision Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__video.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#define-members">Macros</a>  </div>
  <div class="headertitle">
<div class="title">Video Streaming<div class="ingroups"><a class="el" href="group__util.html">Utilities Library (jetson-utils)</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="classvideoSource.html" title="The videoSource API is for capturing frames from video input devices such as MIPI CSI cameras...">videoSource</a> and <a class="el" href="classvideoOutput.html" title="The videoOutput API is for rendering and transmitting frames to video input devices such as display w...">videoOutput</a> APIs for input and output video streams.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structURI.html">URI</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resource <a class="el" href="structURI.html" title="Resource URI of a video device, IP stream, or file/directory. ">URI</a> of a video device, IP stream, or file/directory.  <a href="structURI.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvideoOptions.html">videoOptions</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <a class="el" href="structvideoOptions.html" title="The videoOptions struct contains common settings that are used to configure and query videoSource and...">videoOptions</a> struct contains common settings that are used to configure and query <a class="el" href="classvideoSource.html" title="The videoSource API is for capturing frames from video input devices such as MIPI CSI cameras...">videoSource</a> and <a class="el" href="classvideoOutput.html" title="The videoOutput API is for rendering and transmitting frames to video input devices such as display w...">videoOutput</a> streams.  <a href="structvideoOptions.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classvideoOutput.html">videoOutput</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <a class="el" href="classvideoOutput.html" title="The videoOutput API is for rendering and transmitting frames to video input devices such as display w...">videoOutput</a> API is for rendering and transmitting frames to video input devices such as display windows, broadcasting RTP network streams to remote hosts over UDP/IP, and saving videos/images/directories to disk.  <a href="classvideoOutput.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classvideoSource.html">videoSource</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <a class="el" href="classvideoSource.html" title="The videoSource API is for capturing frames from video input devices such as MIPI CSI cameras...">videoSource</a> API is for capturing frames from video input devices such as MIPI CSI cameras, V4L2 cameras, video/images files from disk, directories containing a sequence of images, and from RTP/RTSP network video streams over UDP/IP.  <a href="classvideoSource.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gaf0923737dee5ff7a8f1a17c4b9c1f2fe"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video.html#gaf0923737dee5ff7a8f1a17c4b9c1f2fe">LOG_VIDEO</a>&#160;&#160;&#160;&quot;[video]  &quot;</td></tr>
<tr class="separator:gaf0923737dee5ff7a8f1a17c4b9c1f2fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga408346b18d1f4c711279010d2351f7ce"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video.html#ga408346b18d1f4c711279010d2351f7ce">VIDEO_OUTPUT_USAGE_STRING</a></td></tr>
<tr class="memdesc:ga408346b18d1f4c711279010d2351f7ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Standard command-line options able to be passed to <a class="el" href="classvideoOutput.html#aa2754b5d31e5466ad35db3f2832209f1" title="Create videoOutput interface from a videoOptions struct that&#39;s already been filled out...">videoOutput::Create()</a>  <a href="#ga408346b18d1f4c711279010d2351f7ce">More...</a><br /></td></tr>
<tr class="separator:ga408346b18d1f4c711279010d2351f7ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2f89bd1b25834e27c1be213ee862d5ae"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video.html#ga2f89bd1b25834e27c1be213ee862d5ae">VIDEO_SOURCE_USAGE_STRING</a></td></tr>
<tr class="memdesc:ga2f89bd1b25834e27c1be213ee862d5ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Standard command-line options able to be passed to <a class="el" href="classvideoSource.html#aadf5947b119db934f02fefcd8ffe23ee" title="Create videoSource interface from a videoOptions struct that&#39;s already been filled out...">videoSource::Create()</a>  <a href="#ga2f89bd1b25834e27c1be213ee862d5ae">More...</a><br /></td></tr>
<tr class="separator:ga2f89bd1b25834e27c1be213ee862d5ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p><a class="el" href="classvideoSource.html" title="The videoSource API is for capturing frames from video input devices such as MIPI CSI cameras...">videoSource</a> and <a class="el" href="classvideoOutput.html" title="The videoOutput API is for rendering and transmitting frames to video input devices such as display w...">videoOutput</a> APIs for input and output video streams. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="gaf0923737dee5ff7a8f1a17c4b9c1f2fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf0923737dee5ff7a8f1a17c4b9c1f2fe">&#9670;&nbsp;</a></span>LOG_VIDEO</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define LOG_VIDEO&#160;&#160;&#160;&quot;[video]  &quot;</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="ga408346b18d1f4c711279010d2351f7ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga408346b18d1f4c711279010d2351f7ce">&#9670;&nbsp;</a></span>VIDEO_OUTPUT_USAGE_STRING</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define VIDEO_OUTPUT_USAGE_STRING</td>
        </tr>
      </table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><span class="stringliteral">&quot;videoOutput arguments: \n&quot;</span>                                                     \</div><div class="line">                  <span class="stringliteral">&quot;    output_URI           resource URI of the output stream, for example:\n&quot;</span>          \</div><div class="line">                  <span class="stringliteral">&quot;                             * file://my_image.jpg    (image file)\n&quot;</span>                        \</div><div class="line">                  <span class="stringliteral">&quot;                             * file://my_video.mp4    (video file)\n&quot;</span>                        \</div><div class="line">                  <span class="stringliteral">&quot;                             * file://my_directory/   (directory of images)\n&quot;</span>       \</div><div class="line">                  <span class="stringliteral">&quot;                             * rtp://&lt;remote-ip&gt;:1234 (RTP stream)\n&quot;</span>                        \</div><div class="line">                  <span class="stringliteral">&quot;                             * display://0            (OpenGL window)\n&quot;</span>             \</div><div class="line">                  <span class="stringliteral">&quot;  --output-codec=CODEC   desired codec for compressed output streams:\n&quot;</span>             \</div><div class="line">                  <span class="stringliteral">&quot;                            * h264 (default), h265\n&quot;</span>                                                \</div><div class="line">                  <span class="stringliteral">&quot;                            * vp8, vp9\n&quot;</span>                                                                    \</div><div class="line">                  <span class="stringliteral">&quot;                            * mpeg2, mpeg4\n&quot;</span>                                                                \</div><div class="line">                  <span class="stringliteral">&quot;                            * mjpeg\n&quot;</span>                                                                       \</div><div class="line">                  <span class="stringliteral">&quot;  --bitrate=BITRATE      desired target VBR bitrate for compressed streams,\n&quot;</span>    \</div><div class="line">                  <span class="stringliteral">&quot;                         in bits per second. The default is 4000000 (4 Mbps)\n&quot;</span>      \</div><div class="line">                  <span class="stringliteral">&quot;  --headless             don&#39;t create a default OpenGL GUI window\n\n&quot;</span></div></div><!-- fragment -->
<p>Standard command-line options able to be passed to <a class="el" href="classvideoOutput.html#aa2754b5d31e5466ad35db3f2832209f1" title="Create videoOutput interface from a videoOptions struct that&#39;s already been filled out...">videoOutput::Create()</a> </p>

</div>
</div>
<a id="ga2f89bd1b25834e27c1be213ee862d5ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2f89bd1b25834e27c1be213ee862d5ae">&#9670;&nbsp;</a></span>VIDEO_SOURCE_USAGE_STRING</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define VIDEO_SOURCE_USAGE_STRING</td>
        </tr>
      </table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><span class="stringliteral">&quot;videoSource arguments: \n&quot;</span>                                                             \</div><div class="line">                  <span class="stringliteral">&quot;    input_URI            resource URI of the input stream, for example:\n&quot;</span>                   \</div><div class="line">                  <span class="stringliteral">&quot;                             * /dev/video0              (V4L2 camera #0)\n&quot;</span>                  \</div><div class="line">                  <span class="stringliteral">&quot;                             * csi://0                  (MIPI CSI camera #0)\n&quot;</span>              \</div><div class="line">                  <span class="stringliteral">&quot;                             * rtp://@:1234             (RTP stream)\n&quot;</span>                              \</div><div class="line">                  <span class="stringliteral">&quot;                             * rtsp://user:pass@ip:1234 (RTSP stream)\n&quot;</span>                     \</div><div class="line">                  <span class="stringliteral">&quot;                             * file://my_image.jpg      (image file)\n&quot;</span>                              \</div><div class="line">                  <span class="stringliteral">&quot;                             * file://my_video.mp4      (video file)\n&quot;</span>                              \</div><div class="line">                  <span class="stringliteral">&quot;                             * file://my_directory/     (directory of images)\n&quot;</span>             \</div><div class="line">                  <span class="stringliteral">&quot;  --input-width=WIDTH    explicitly request a width of the stream (optional)\n&quot;</span>      \</div><div class="line">                  <span class="stringliteral">&quot;  --input-height=HEIGHT  explicitly request a height of the stream (optional)\n&quot;</span>     \</div><div class="line">                  <span class="stringliteral">&quot;  --input-rate=RATE      explicitly request a framerate of the stream (optional)\n&quot;</span>  \</div><div class="line">                  <span class="stringliteral">&quot;  --input-codec=CODEC    RTP requires the codec to be set, one of these:\n&quot;</span>                  \</div><div class="line">                  <span class="stringliteral">&quot;                             * h264, h265\n&quot;</span>                                                                 \</div><div class="line">                  <span class="stringliteral">&quot;                             * vp8, vp9\n&quot;</span>                                                                   \</div><div class="line">                  <span class="stringliteral">&quot;                             * mpeg2, mpeg4\n&quot;</span>                                                                       \</div><div class="line">                  <span class="stringliteral">&quot;                             * mjpeg\n&quot;</span>                                                                      \</div><div class="line">                  <span class="stringliteral">&quot;  --input-flip=FLIP      flip method to apply to input (excludes V4L2):\n&quot;</span>                   \</div><div class="line">                  <span class="stringliteral">&quot;                             * none (default)\n&quot;</span>                                                             \</div><div class="line">                  <span class="stringliteral">&quot;                             * counterclockwise\n&quot;</span>                                                           \</div><div class="line">                  <span class="stringliteral">&quot;                             * rotate-180\n&quot;</span>                                                                         \</div><div class="line">                  <span class="stringliteral">&quot;                             * clockwise\n&quot;</span>                                                                  \</div><div class="line">                  <span class="stringliteral">&quot;                             * horizontal\n&quot;</span>                                                                         \</div><div class="line">                  <span class="stringliteral">&quot;                             * vertical\n&quot;</span>                                                                   \</div><div class="line">                  <span class="stringliteral">&quot;                             * upper-right-diagonal\n&quot;</span>                                                       \</div><div class="line">                  <span class="stringliteral">&quot;                             * upper-left-diagonal\n&quot;</span>                                                        \</div><div class="line">                  <span class="stringliteral">&quot;  --input-loop=LOOP      for file-based inputs, the number of loops to run:\n&quot;</span>               \</div><div class="line">                  <span class="stringliteral">&quot;                             * -1 = loop forever\n&quot;</span>                                                          \</div><div class="line">                  <span class="stringliteral">&quot;                             *  0 = don&#39;t loop (default)\n&quot;</span>                                          \</div><div class="line">                  <span class="stringliteral">&quot;                             * &gt;0 = set number of loops\n\n&quot;</span></div></div><!-- fragment -->
<p>Standard command-line options able to be passed to <a class="el" href="classvideoSource.html#aadf5947b119db934f02fefcd8ffe23ee" title="Create videoSource interface from a videoOptions struct that&#39;s already been filled out...">videoSource::Create()</a> </p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Generated on Tue Jul 14 2020 21:59:34 for Jetson Inference by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
